ccmc::Tracer Class Reference

TODO: Brief description. More...

#include <Tracer.h>

Collaboration diagram for ccmc::Tracer:

Public Types
enum	Direction { FOWARD, REVERSE }

Public Member Functions
	Tracer (Kameleon *kameleon)
	Tracer (Kameleon *kameleon, Interpolator *interpolator)
	~Tracer ()
void	setInnerBoundary (float r_end)
void	setMaxIterations (int stepMax)
void	setDn (float dn)
void	setTilt (float tilt)
void	setMissing (float missing)
void	setMaxArcLength (float maxArcLength)
Fieldline	bidirectionalTrace (const std::string &variable, const float &startComponent1, const float &startComponent2, const float &startComponent3)
Fieldline	bidirectionalTraceWithDipole (const std::string &variable, const float &startComponent1, const float &startComponent2, const float &startComponent3)
Fieldline	unidirectionalTrace (const std::string &variable, const float &startComponent1, const float &startComponent2, const float &startComponent3, const Direction &dir=FOWARD)
Fieldline	unidirectionalTraceWithDipole (const std::string &variable, const float &startComponent1, const float &startComponent2, const float &startComponent3, const Direction &dir=FOWARD)
Fieldline	findLastClosed (Point3f position, int stepMax)
std::vector< Fieldline >	getLastClosedFieldlines (int numberOfFieldlines, int stepMax, int numberOfPointsPerReducedFieldline)
bool	isClosed (Fieldline &fieldline)
void	setUseMaxArcLength (bool useMaxArcLength)
Point3f	getVector (const std::string &variable, const Point3f &position, float &dComponent1, float &dComponent2, float &dComponent3, const Interpolator *interpolator)
void	setRegionOfInterest (Point3f min, Point3f max)
void	setUseRegionOfInterest (bool useROI)

Public Attributes
Interpolator *	interpolator

Detailed Description

TODO: Brief description.

Full Description of Tracer class

Member Enumeration Documentation

enum ccmc::Tracer::Direction

Enumerator
FOWARD
REVERSE

Constructor & Destructor Documentation

ccmc::Tracer::Tracer

(

Kameleon *

kameleon

)

TODO: finish documentation

Parameters

kameleon

Here is the call graph for this function:

ccmc::Tracer::Tracer	(	Kameleon *	kameleon,
		Interpolator *	interpolator
	)

Here is the call graph for this function:

ccmc::Tracer::~Tracer

(

)

TODO: finish documentation

Member Function Documentation

Fieldline ccmc::Tracer::bidirectionalTrace	(	const std::string &	variable,
		const float &	startComponent1,
		const float &	startComponent2,
		const float &	startComponent3
	)

TODO: finish documentation

Parameters

variable
startComponent1
startComponent2
startComponent3

Here is the call graph for this function:

Fieldline ccmc::Tracer::bidirectionalTraceWithDipole	(	const std::string &	variable,
		const float &	startComponent1,
		const float &	startComponent2,
		const float &	startComponent3
	)

Opens a CCMC generated CDF file and initializes the model name

Parameters

filename	The filename of the cdf file to open. Closes the opened CDF file Loads the variable, including all components of the variable, into memory. For example, if variable is "bx", three variables will be loaded: "bx", "by", and "bz"
variable	TODO: finish documentation
variable
startComponent1
startComponent2
startComponent3

Here is the call graph for this function:

Fieldline ccmc::Tracer::findLastClosed	(	Point3f	position,
		int	stepMax
	)

TODO: finish documentation

Parameters

position
stepMax

Returns

Here is the call graph for this function:

vector< Fieldline > ccmc::Tracer::getLastClosedFieldlines	(	int	numberOfFieldlines,
		int	stepMax,
		int	numberOfPointsPerReducedFieldline
	)

TODO: finish documentation

Parameters

numberOfFieldlines
stepMax
numberOfPointsPerReducedFieldline

Returns

add the first point all the time

always add the last point too, since i was reduced by one

Here is the call graph for this function:

Point3f ccmc::Tracer::getVector	(	const std::string &	variable,
		const Point3f &	position,
		float &	dComponent1,
		float &	dComponent2,
		float &	dComponent3,
		const Interpolator *	interpolator
	)

check to see if iterations are greater than or equal to max I should have changed the name but it would have been too long TODO: finish documentation TODO: return missing value if variable not found TODO: use a map instead of an if/else statement to check for the variable

Parameters

variable
position
dComponent1
dComponent2
dComponent3
interpolator

Returns

bool ccmc::Tracer::isClosed

(

Fieldline &

fieldline

)

TODO: finish documentation

Parameters

fieldline

Returns

Here is the call graph for this function:

void ccmc::Tracer::setDn

(

float

dn

)

TODO: finish documentation

Parameters

dn

void ccmc::Tracer::setInnerBoundary

(

float

r_end

)

TODO: finish documentation

Parameters

r_end

void ccmc::Tracer::setMaxArcLength

(

float

maxArcLength

)

Parameters

maxArcLength

void ccmc::Tracer::setMaxIterations

(

int

stepMax

)

TODO: finish documentation

Parameters

stepMax

void ccmc::Tracer::setMissing

(

float

missing

)

Parameters

missing

void ccmc::Tracer::setRegionOfInterest	(	Point3f	min,
		Point3f	max
	)

Parameters

min
max

void ccmc::Tracer::setTilt

(

float

tilt

)

Parameters

tilt

void ccmc::Tracer::setUseMaxArcLength

(

bool

useMaxArcLength

)

Parameters

useMaxArcLength

void ccmc::Tracer::setUseRegionOfInterest

(

bool

useROI

)

Parameters

useROI

Fieldline ccmc::Tracer::unidirectionalTrace	(	const std::string &	variable,
		const float &	startComponent1,
		const float &	startComponent2,
		const float &	startComponent3,
		const Direction &	dir = FOWARD
	)

TODO: finish documentation

Parameters

variable
startComponent1
startComponent2
startComponent3
dir

Here is the call graph for this function:

Fieldline ccmc::Tracer::unidirectionalTraceWithDipole	(	const std::string &	variable,
		const float &	startComponent1,
		const float &	startComponent2,
		const float &	startComponent3,
		const Direction &	dir = FOWARD
	)

TODO: finish documentation

Parameters

variable
startComponent1
startComponent2
startComponent3
dir

Here is the call graph for this function:

Member Data Documentation

Interpolator* ccmc::Tracer::interpolator

---

The documentation for this class was generated from the following files:

• /Users/apembrok/Documents/workspaces/workspace.bak2/workspace.backup/kameleon-plus/src/ccmc/Tracer.h
• /Users/apembrok/Documents/workspaces/workspace.bak2/workspace.backup/kameleon-plus/src/ccmc/Tracer.cpp